fix: deprecate "chisel-v1" format #150
Conversation
This commit depreciates support for the "chisel-v1" format in chisel.
Notably the following fields/values are no longer supported:
- The "chisel-v1" value for top-level field "format". Use "v1"
instead.
- The "<archive>.v1-public-keys" field. Use "<archive>.public-keys"
instead.
- The top-level "v1-public-keys" field. Use "public-keys" instead.
BREAKING CHANGE: New versions of chisel which includes this commit will
no longer support the "chisel-v1" format in chisel-releases. Either
update the "chisel.yaml" file in chisel-releases or use a lower
version which does not have this commit.
letFunny
force-pushed
the
deprecate-chisel-v1
branch
from
c7b49ba
to
322d890
Compare
| armor: |` + "\n" + testutil.PrefixEachLine(testKey.PubKeyArmor, "\t\t\t\t\t\t") + ` | ||
| `, | ||
| }, | ||
| relerror: `chisel.yaml: unknown format "chisel-v1"`, |
There was a problem hiding this comment.
[Question for reviewer]: The only question is whether we should introduce a better error message for chisel-v1 that says something like "consider an update if available" just like we do for invalid generate: values.
There was a problem hiding this comment.
Per the conversation we had, to introduce such a message we need to do that at the very top layer, in the user interface itself (CLI, or GUI) as otherwise we cannot tell the context in which the library/package is being used. Even there, sometimes it may be misleading as the tool may be leveraged in servers and the error reported in a way that is impossible for the receiver of the message to act on the suggestion. For that kind of reason, it is usually better to report the error with a good error message which allows the reader to grasp what is going on by themselves, which seems like the case here already.
This commit depreciates support for the "chisel-v1" format in chisel. Notably the following fields/values are no longer supported:
BREAKING CHANGE: New versions of chisel which includes this commit will
no longer support the "chisel-v1" format in chisel-releases. Either
update the "chisel.yaml" file in chisel-releases or use a lower
version which does not have this commit.